dcmotor28fng.h File Reference

This file contains API for DC Motor 28 FNG Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	dcmotor28fng_t
	DC Motor 28 FNG Click context object. More...
struct	dcmotor28fng_cfg_t
	DC Motor 28 FNG Click configuration object. More...

Macros
#define	DCMOTOR28FNG_RISENSE_V_TO_MA   1.0
	DC Motor 28 FNG current calculation setting.
#define	DCMOTOR28FNG_NUM_CONVERSIONS   200
	DC Motor 28 FNG default ADC samples number for averaging.
#define	DCMOTOR28FNG_VREF_3V3   3.3
	DC Motor 28 FNG ADC setting.
#define	DCMOTOR28FNG_VREF_5V   5.0
#define	DCMOTOR28FNG_VREF_DEFAULT   DCMOTOR28FNG_VREF_3V3
#define	DCMOTOR28FNG_TIMEOUT_MS   2000
	DC Motor 28 FNG timeout setting.
#define	DCMOTOR28FNG_MOTOR_COAST   0
	DC Motor 28 FNG motor PWM control mode setting.
#define	DCMOTOR28FNG_MOTOR_FORWARD   1
#define	DCMOTOR28FNG_MOTOR_REVERSE   2
#define	DCMOTOR28FNG_MOTOR_BRAKE   3
#define	DCMOTOR28FNG_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	dcmotor28fng_return_value_t { DCMOTOR28FNG_OK = 0 , DCMOTOR28FNG_ERROR = -1 }
	DC Motor 28 FNG Click return value data. More...

Functions
void	dcmotor28fng_cfg_setup (dcmotor28fng_cfg_t *cfg)
	DC Motor 28 FNG configuration object setup function.
err_t	dcmotor28fng_init (dcmotor28fng_t *ctx, dcmotor28fng_cfg_t *cfg)
	DC Motor 28 FNG initialization function.
err_t	dcmotor28fng_read_adc_raw (dcmotor28fng_t *ctx, uint16_t *data_out)
	DC Motor 28 FNG read raw ISENSE ADC value function.
err_t	dcmotor28fng_read_adc_volt (dcmotor28fng_t *ctx, float *data_out)
	DC Motor 28 FNG read ISENSE pin voltage level function.
err_t	dcmotor28fng_read_adc_volt_avg (dcmotor28fng_t *ctx, uint16_t num_conv, float *volt_avg)
	DC Motor 28 FNG read ISENSE pin voltage level average function.
err_t	dcmotor28fng_set_adc_vref (dcmotor28fng_t *ctx, float vref)
	DC Motor 28 FNG set vref function.
void	dcmotor28fng_set_in1_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG set IN1 pin function.
void	dcmotor28fng_clear_in1_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG clear IN1 pin function.
void	dcmotor28fng_set_in2_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG set IN2 pin function.
void	dcmotor28fng_clear_in2_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG clear IN2 pin function.
void	dcmotor28fng_set_sleep_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG set SLEEP pin function.
void	dcmotor28fng_clear_sleep_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG clear SLEEP pin function.
uint8_t	dcmotor28fng_get_fault_pin (dcmotor28fng_t *ctx)
	DC Motor 28 FNG get FAULT pin function.
void	dcmotor28fng_drive_motor (dcmotor28fng_t *ctx, uint8_t state)
	DC Motor 28 FNG drive motor function.
err_t	dcmotor28fng_calib_offset (dcmotor28fng_t *ctx)
	DC Motor 28 FNG calib offset function.
err_t	dcmotor28fng_get_out_current (dcmotor28fng_t *ctx, float *current)
	DC Motor 28 FNG get out current function.

Detailed Description

This file contains API for DC Motor 28 FNG Click Driver.

Enumeration Type Documentation

dcmotor28fng_return_value_t

enum dcmotor28fng_return_value_t

DC Motor 28 FNG Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR28FNG_OK
DCMOTOR28FNG_ERROR